fix(ENG-2912): CLI typos and doc changes#154
Conversation
|
@ralph-mcteggart Your tests are (false positive) timing out because they're waiting for |
Cheers @chrisimcevoy! Was aware but haven't got round to fixing it. Appreciate the heads up though 😁 |
|
Code Climate has analyzed commit 99e0d00 and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 71.5% (0.0% change). View more on Code Climate. |
There was a problem hiding this comment.
Pull request overview
- Updates CLI-facing text and documentation to fix typos/inconsistencies (primarily standardizing wording like “organization” / “synchronization”) across help strings, docstrings, tests, and README command listings.
Changes:
- Corrected quarantine command description in README and standardized “organization” wording.
- Standardized “synchronization” spelling in CLI help/docstrings and push output messages.
- Renamed a test helper parameter to match the existing
organizationfixture naming.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Fixes command list wording and standardizes “organization” terminology. |
| cloudsmith_cli/cli/tests/commands/test_repos.py | Aligns test helper parameter naming with organization fixture usage. |
| cloudsmith_cli/cli/decorators.py | Updates Click option help strings to “synchronization/resynchronize”. |
| cloudsmith_cli/cli/commands/upstream.py | Standardizes docstring wording to “organization”. |
| cloudsmith_cli/cli/commands/status.py | Updates command help text to “synchronization”. |
| cloudsmith_cli/cli/commands/quota/quota.py | Standardizes quota subcommand help text to “organization”. |
| cloudsmith_cli/cli/commands/quota/history.py | Standardizes quota history help text to “organization”. |
| cloudsmith_cli/cli/commands/quota/command.py | Standardizes quota command docstring to “organization”. |
| cloudsmith_cli/cli/commands/push.py | Standardizes sync-related docstrings/output messages to “synchronize”. |
| cloudsmith_cli/cli/commands/policy/vulnerability.py | Standardizes policy help text to “organization”. |
| cloudsmith_cli/cli/commands/policy/license.py | Standardizes policy help text to “organization”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `limits`: Display the Quota (bandwidth & storage usage/limits) for a specific organisation. | ||
| - `history`: Display the Quota History (upload, download, and storage usage/limits) for a specific organisation. | ||
| - `remove`|`rm`|`restore`: Remove a package from quarantine. | ||
| - `quota`: Quota limits and history for a organization. |
| ctx, opts, owner, repo, slug, wait_interval, skip_errors, attempts=3 | ||
| ): | ||
| """Wait for a package to synchronise (or fail).""" | ||
| """Wait for a package to synchronize (or fail).""" |
I was originally looking here for a defect related to the CLI before realising the required changes were in the API.
When reading through the docs I noticed some inconsistencies so updated while I was here
(ENG-2912)